Skip to content

Rename "Insights Advisor" to "Red Hat Lightspeed Advisor" in API docs#2911

Open
Jakub007d wants to merge 1 commit into
openshift:masterfrom
Jakub007d:advisor-rename
Open

Rename "Insights Advisor" to "Red Hat Lightspeed Advisor" in API docs#2911
Jakub007d wants to merge 1 commit into
openshift:masterfrom
Jakub007d:advisor-rename

Conversation

@Jakub007d

Copy link
Copy Markdown

Rename all "Insights Advisor" references in API field descriptions to "Red Hat Lightspeed Advisor" across operator/v1, insights/v1, insights/v1alpha1, and insights/v1alpha2 types.
The generated swagger docs, CRD manifests, and OpenAPI specs were updated with make update.

Ref: https://redhat.atlassian.net/browse/HCCDOC-4522

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

@openshift-ci openshift-ci Bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 2, 2026
@openshift-ci

openshift-ci Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Hello @Jakub007d! Some important instructions when contributing to openshift/api:
API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

@openshift-ci openshift-ci Bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 2, 2026
@openshift-ci

openshift-ci Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Hi @Jakub007d. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 8500e63a-34d1-409e-8670-5f69ad1b688f

📥 Commits

Reviewing files that changed from the base of the PR and between 9e961bd and 656e782.

⛔ Files ignored due to path filters (14)
  • insights/v1/zz_generated.crd-manifests/0000_10_insights_01_datagathers.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
  • insights/v1/zz_generated.featuregated-crd-manifests/datagathers.insights.openshift.io/InsightsOnDemandDataGather.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
  • insights/v1/zz_generated.swagger_doc_generated.go is excluded by !**/zz_generated*
  • insights/v1alpha1/zz_generated.crd-manifests/0000_10_insights_01_datagathers.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
  • insights/v1alpha1/zz_generated.featuregated-crd-manifests/datagathers.insights.openshift.io/InsightsOnDemandDataGather.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
  • insights/v1alpha1/zz_generated.swagger_doc_generated.go is excluded by !**/zz_generated*
  • insights/v1alpha2/zz_generated.crd-manifests/0000_10_insights_01_datagathers.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
  • insights/v1alpha2/zz_generated.featuregated-crd-manifests/datagathers.insights.openshift.io/InsightsOnDemandDataGather.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
  • insights/v1alpha2/zz_generated.swagger_doc_generated.go is excluded by !**/zz_generated*
  • openapi/generated_openapi/zz_generated.openapi.go is excluded by !openapi/**, !**/zz_generated*
  • openapi/openapi.json is excluded by !openapi/**
  • operator/v1/zz_generated.crd-manifests/0000_50_insights_00_insightsoperators.crd.yaml is excluded by !**/zz_generated.crd-manifests/*
  • operator/v1/zz_generated.featuregated-crd-manifests/insightsoperators.operator.openshift.io/AAA_ungated.yaml is excluded by !**/zz_generated.featuregated-crd-manifests/**
  • operator/v1/zz_generated.swagger_doc_generated.go is excluded by !**/zz_generated*
📒 Files selected for processing (5)
  • insights/v1/types_insights.go
  • insights/v1alpha1/types_insights.go
  • insights/v1alpha2/types_insights.go
  • operator/v1/types_insights.go
  • payload-manifests/crds/0000_10_insights_01_datagathers.crd.yaml
🚧 Files skipped from review as they are similar to previous changes (4)
  • payload-manifests/crds/0000_10_insights_01_datagathers.crd.yaml
  • insights/v1/types_insights.go
  • insights/v1alpha2/types_insights.go
  • insights/v1alpha1/types_insights.go

📝 Walkthrough

Walkthrough

Updated HealthCheck Advisor documentation across API versions and the operator types, along with the corresponding CRD schema description. References to “Insights Advisor” now use “Red Hat Lightspeed Advisor” terminology. Field definitions, JSON tags, validation markers, and behavior remain unchanged.

Suggested reviewers: joelspeed, everettraven

🚥 Pre-merge checks | ✅ 15
✅ Passed checks (15 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: renaming Insights Advisor to Red Hat Lightspeed Advisor in API docs.
Description check ✅ Passed The description matches the changeset and mentions the updated API docs, Swagger, CRD manifests, and OpenAPI specs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names ✅ Passed Diff only updates API descriptions and generated docs/manifests; no Ginkgo test titles were added or edited.
Test Structure And Quality ✅ Passed No Ginkgo or other test code was changed; the PR only renames documentation/comments and generated manifests, so the test-structure check is not applicable.
Microshift Test Compatibility ✅ Passed No Ginkgo e2e tests were added or modified; the patch only updates API docs and generated manifests.
Single Node Openshift (Sno) Test Compatibility ✅ Passed PR only updates API/docs comments and generated schema text; no new Ginkgo e2e tests or SNO-sensitive assumptions were added.
Topology-Aware Scheduling Compatibility ✅ Passed Only API/CRD/OpenAPI descriptions changed; no scheduling fields, pod specs, replicas, affinities, tolerations, or controllers were modified.
Ote Binary Stdout Contract ✅ Passed PR only rewrites generated/docs comments; no init/main/TestMain/setup code or stdout writes were added.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed No new Ginkgo/e2e tests were added; the PR only rewords API/CRD comments and generated docs, with no networking or connectivity logic.
No-Weak-Crypto ✅ Passed Touched files only reword API docs/comments; exact searches found no MD5/SHA1/DES/RC4/3DES/Blowfish/ECB or secret-comparison code in the changed files.
Container-Privileges ✅ Passed Docs-only API description changes; changed manifests contain no privileged, hostPID/Network/IPC, CAP_SYS_ADMIN, or allowPrivilegeEscalation settings.
No-Sensitive-Data-In-Logs ✅ Passed Patch only rewords API docs/CRD descriptions; no logging code or sensitive-data fields were added.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (2.12.2)

Error: build linters: unable to load custom analyzer "kubeapilinter": tools/_output/bin/kube-api-linter.so, plugin: not implemented
The command is terminated due to an error: build linters: unable to load custom analyzer "kubeapilinter": tools/_output/bin/kube-api-linter.so, plugin: not implemented


Comment @coderabbitai help to get the list of available commands.

Comment thread insights/v1/types_insights.go Outdated
Comment thread insights/v1alpha1/types_insights.go Outdated
Comment thread insights/v1/zz_generated.crd-manifests/0000_10_insights_01_datagathers.crd.yaml Outdated
Comment thread insights/v1alpha2/types_insights.go Outdated
Comment thread payload-manifests/crds/0000_10_insights_01_datagathers.crd.yaml Outdated

@michelle-purcell michelle-purcell left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jakub - I reviewed the PR from the docs perspective for Red Hat style and grammar guidelines. Looks great. Just a few comments and suggestions. Thank you for your help with these updates 😄

@michelle-purcell

Copy link
Copy Markdown

/lgtm - my comments are non-critcal.

@Jakub007d
Jakub007d force-pushed the advisor-rename branch 2 times, most recently from 4c3cf58 to 212a921 Compare July 7, 2026 13:31
@Jakub007d
Jakub007d marked this pull request as ready for review July 9, 2026 11:06
@openshift-ci openshift-ci Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 9, 2026
@openshift-ci
openshift-ci Bot requested review from JoelSpeed and everettraven July 9, 2026 11:06
@JoelSpeed

Copy link
Copy Markdown
Contributor

I'm not necessarily familiar with what's happened on the rebrand here, is Insights Advisor always Lightspeed advisor UI now?

@michelle-purcell

Copy link
Copy Markdown

I'm not necessarily familiar with what's happened on the rebrand here, is Insights Advisor always Lightspeed advisor UI now?

Yes. It's the Red Hat Lightspeed Advisor UI (and it's Red Hat Lightspeed advisor service (lowercase a in this context)

@JoelSpeed

Copy link
Copy Markdown
Contributor

/lgtm
/verified by CI

@JoelSpeed

Copy link
Copy Markdown
Contributor

/ok-to-test

@openshift-ci openshift-ci Bot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Jul 10, 2026
@openshift-ci openshift-ci Bot added lgtm Indicates that a PR is ready to be merged. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 10, 2026
@openshift-merge-bot

Copy link
Copy Markdown
Contributor

Scheduling tests matching the pipeline_run_if_changed or not excluded by pipeline_skip_if_only_changed parameters:
/test e2e-aws-ovn
/test e2e-aws-ovn-hypershift
/test e2e-aws-ovn-hypershift-conformance
/test e2e-aws-ovn-techpreview
/test e2e-aws-serial-1of2
/test e2e-aws-serial-2of2
/test e2e-aws-serial-techpreview-1of2
/test e2e-aws-serial-techpreview-2of2
/test e2e-azure
/test e2e-gcp
/test e2e-upgrade
/test e2e-upgrade-out-of-change
/test minor-e2e-upgrade-minor

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 10, 2026
@openshift-merge-bot

Copy link
Copy Markdown
Contributor

/retest-required

Remaining retests: 0 against base HEAD a3d85be and 2 for PR HEAD 212a921 in total

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

/retest-required

Remaining retests: 0 against base HEAD fa22e69 and 1 for PR HEAD 212a921 in total

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

/retest-required

Remaining retests: 0 against base HEAD d8a1748 and 0 for PR HEAD 212a921 in total

@openshift-merge-bot

Copy link
Copy Markdown
Contributor

/hold

Revision 212a921 was retested 3 times: holding

@openshift-ci openshift-ci Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 11, 2026
@JoelSpeed

Copy link
Copy Markdown
Contributor

You'll need to run PROTO_OPTIONAL=1 make update to generate the out-of-date content here

@openshift-ci openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Jul 14, 2026
@JoelSpeed

Copy link
Copy Markdown
Contributor

/hold cancel
/lgtm

@openshift-ci openshift-ci Bot added lgtm Indicates that a PR is ready to be merged. and removed do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Jul 16, 2026
@openshift-merge-bot

Copy link
Copy Markdown
Contributor

Scheduling tests matching the pipeline_run_if_changed or not excluded by pipeline_skip_if_only_changed parameters:
/test e2e-aws-ovn
/test e2e-aws-ovn-hypershift
/test e2e-aws-ovn-hypershift-conformance
/test e2e-aws-ovn-techpreview
/test e2e-aws-serial-1of2
/test e2e-aws-serial-2of2
/test e2e-aws-serial-techpreview-1of2
/test e2e-aws-serial-techpreview-2of2
/test e2e-azure
/test e2e-gcp
/test e2e-upgrade
/test e2e-upgrade-out-of-change
/test minor-e2e-upgrade-minor

@openshift-ci

openshift-ci Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JoelSpeed, michelle-purcell

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@Jakub007d

Copy link
Copy Markdown
Author

/retest

1 similar comment
@Jakub007d

Copy link
Copy Markdown
Author

/retest

@openshift-ci openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Jul 20, 2026
@openshift-ci

openshift-ci Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

New changes are detected. LGTM label has been removed.

@Jakub007d

Copy link
Copy Markdown
Author

/retest

@Jakub007d

Copy link
Copy Markdown
Author

/retest-required

1 similar comment
@Jakub007d

Copy link
Copy Markdown
Author

/retest-required

@openshift-ci

openshift-ci Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

@Jakub007d: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-aws-ovn-techpreview 9e961bd link true /test e2e-aws-ovn-techpreview
ci/prow/minor-e2e-upgrade-minor 9e961bd link true /test minor-e2e-upgrade-minor
ci/prow/e2e-aws-ovn 9e961bd link true /test e2e-aws-ovn
ci/prow/verify-hypershift-integration 656e782 link true /test verify-hypershift-integration

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. verified Signifies that the PR passed pre-merge verification criteria

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants